Skip to content

Document create and update rejection messages - #98

Merged
dmccoystephenson merged 1 commit into
mainfrom
feat/document-create-update-rejection-messages
Nov 16, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feat/document-create-update-rejection-messages

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

A Stage A documentation sweep found that README.md quotes the exact message for most rejections, but not for the create and update rejections listed below. Those messages have now been added:

  • create (CreateProjectCommand.execute): the name-taken message Project name '<project-name>' is already taken. Please choose a different name., and Project name cannot be empty. / Project description cannot be empty. for an empty or whitespace-only name or description.
  • update (UpdateProjectCommand.execute): Nothing to update. Provide at least one of --description, --impact, --confidence, --ease, --reach or --effort., Project description cannot be empty. and All scores must be between 1 and 5. These are now listed as bullets. It is also stated that the options are checked before the project is looked up, so update with no options reports Nothing to update even for a name that no project has. This follows the order of the checks in UpdateProjectCommand.execute.

Each quoted message was compared word for word against the source string and the test that asserts it (CreateProjectCommandTest:212,229,353, UpdateProjectCommandTest:122,135,162).

No tracking issue: these gaps were found during the sweep.

Skipped this cycle: #27 (controller endpoints) stays deferred. Its design questions are still open, and it would add a web dependency to build.gradle, which is on the do-not-auto-merge list. The reasons are already recorded on the issue.

Test plan

  • ./gradlew test on JDK 21: 195 tests, 0 failures, 0 errors, 0 skipped (counted from build/test-results/test/*.xml)
  • Each documented message checked against the source and its existing test assertion

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Test Results

195 tests  ±0   195 ✅ ±0   2s ⏱️ ±0s
 25 suites ±0     0 💤 ±0 
 25 files   ±0     0 ❌ ±0 

Results for commit 267e62a. ± Comparison against base commit 1331d1c.

@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (PR #98):

  • Scope: PASS. Only README.md is modified (+11/−2). Every changed line documents a create or update rejection message.
  • Tests-new: PASS (not applicable). No production code was changed, so there are no new public methods.
  • Tests-fix: not applicable. No bug fix is included, and the stash-and-run check has nothing to revert.
  • Sibling structure: PASS. Messages are quoted inline in backticks, as in the List, Delete and Export sections. The new update bullet list follows the Usage reporting opt-out list.
  • Sibling renames: not applicable. No identifiers were renamed.
  • Docs: PASS. Each quoted string matches the source: CreateProjectCommand.java ("Project name cannot be empty.", "Project description cannot be empty.", "Project name '" + projectName + "' is already taken. Please choose a different name.") and UpdateProjectCommand.java (the three guard returns). CONTRIBUTING.md is not affected.
  • Issue resolution: not applicable. No Closes reference; the gap was found during a sweep.
  • Manual validation: PASS. Local ./gradlew test on JDK 21 ran 195 tests with 0 failures. CI build (21), test and Test Results are green on the PR head.
  • Shell command tests / Round-trip coverage / I/O behind an interface: not applicable. No command, domain or I/O code was touched.

Inline-style notes:

  • README.md:167: this line was checked against the order of the guards in UpdateProjectCommand.execute. The empty-options check returns before projectService.updateProject is called, so the Nothing to update message for an unknown name is accurate.
  • README.md:162: when more than one problem is present, only the first failing check is reported, in the order the bullets are listed. That order matches the source, so it was not called out separately.

The rubric found no FAIL items. Because a docs-only diff gives the reviewer little to check, each quoted message was verified against both the source string and its test assertion (CreateProjectCommandTest:212,229,353, UpdateProjectCommandTest:122,135,162).

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 735d94a into main Nov 16, 2026
3 checks passed
@dmccoystephenson
dmccoystephenson deleted the feat/document-create-update-rejection-messages branch November 16, 2026 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant